file object

This method will read a file until a specified string is found.

string read_until(string text, bool require_full)

Parameters:
text
The text to search for in the file.
require_full
A boolean value specifying whether the full text should be found before the file stops reading, or any character in the sequence.

Return value:
A string containing the retrieved data on success, the entire text if the file was successfully read but the string not found, or an empty string if data is unretrievable.

Remarks:
The data returned will include the search string. If the search string cannot be found, the entire text, if any, will be returned by this function.

Example:
// Read a file and display the first line of its content in an alert box.

void main()
{
file test;
test.open("test.txt", "r");
alert("test.txt contents", test.read_until("\r\n",true));
}